Cisco-IOS-XR-qos-ma-oper API API Reference
API generated from Cisco-IOS-XR-qos-ma-oper@2017-09-13.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/URL '/' code: %2F
Schemes: http
Version: 1.0.0
Paths
QOS - Retrieve
Retrieve operation of resource: qos
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-table": {
"interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
}
NV-INTERFACE-TABLE - Retrieve
Retrieve operation of resource: nv-interface-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
NODES - Retrieve
Retrieve operation of resource: nodes
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"node": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
NODE - Retrieve
Retrieve operation of resource: node
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
INPUT - Retrieve
Retrieve operation of resource: input
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
MEMBER-INTERFACES - Retrieve
Retrieve operation of resource: member-interfaces
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"member-interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
MEMBER-INTERFACE - Retrieve
Retrieve operation of resource: member-interface
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
SATELLITE-IDS - Retrieve
Retrieve operation of resource: satellite-ids
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"satellite-id": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
SATELLITE-ID - Retrieve
Retrieve operation of resource: satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
INPUT - Retrieve
Retrieve operation of resource: input
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
INPUT - Retrieve
Retrieve operation of resource: input
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
SATELLITE-IDS - Retrieve
Retrieve operation of resource: satellite-ids
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"satellite-id": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
SATELLITE-ID - Retrieve
Retrieve operation of resource: satellite-id
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
INPUT - Retrieve
Retrieve operation of resource: input
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
INPUT - Retrieve
Retrieve operation of resource: input
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
NV-SATELLITE - Retrieve
Retrieve operation of resource: nv-satellite
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nv-satellite-status": {
"nv-satellite-ids": {
"nv-satellite-id": [
{
"nv-satellite-interfaces": {
"nv-satellite-interface": [
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"satellite-id": "string"
}
]
}
},
"nv-satellite-statistics": {
"nv-satellite-ids": {
"nv-satellite-id": [
{
"nv-satellite-interfaces": {
"nv-satellite-interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
}
]
}
}
}
NV-SATELLITE-STATISTICS - Retrieve
Retrieve operation of resource: nv-satellite-statistics
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nv-satellite-ids": {
"nv-satellite-id": [
{
"nv-satellite-interfaces": {
"nv-satellite-interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
}
]
}
}
NV-SATELLITE-IDS - Retrieve
Retrieve operation of resource: nv-satellite-ids
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nv-satellite-id": [
{
"nv-satellite-interfaces": {
"nv-satellite-interface": [
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"satellite-id": "string"
}
]
}
NV-SATELLITE-ID - Retrieve
Retrieve operation of resource: nv-satellite-id
satellite-id:
string
in path
ID of satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nv-satellite-interfaces": {
"nv-satellite-interface": [
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"satellite-id": "string"
}
NV-SATELLITE-INTERFACES - Retrieve
Retrieve operation of resource: nv-satellite-interfaces
satellite-id:
string
in path
ID of satellite-id
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nv-satellite-interface": [
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
}
NV-SATELLITE-INTERFACE - Retrieve
Retrieve operation of resource: nv-satellite-interface
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
MEMBER-INTERFACES - Retrieve
Retrieve operation of resource: member-interfaces
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"member-interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
MEMBER-INTERFACE - Retrieve
Retrieve operation of resource: member-interface
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
SATELLITE-IDS - Retrieve
Retrieve operation of resource: satellite-ids
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"satellite-id": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
SATELLITE-ID - Retrieve
Retrieve operation of resource: satellite-id
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
INPUT - Retrieve
Retrieve operation of resource: input
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
INPUT - Retrieve
Retrieve operation of resource: input
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
INPUT - Retrieve
Retrieve operation of resource: input
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
NV-SATELLITE-STATUS - Retrieve
Retrieve operation of resource: nv-satellite-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nv-satellite-ids": {
"nv-satellite-id": [
{
"nv-satellite-interfaces": {
"nv-satellite-interface": [
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"satellite-id": "string"
}
]
}
}
NV-SATELLITE-IDS - Retrieve
Retrieve operation of resource: nv-satellite-ids
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nv-satellite-id": [
{
"nv-satellite-interfaces": {
"nv-satellite-interface": [
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"satellite-id": "string"
}
]
}
NV-SATELLITE-ID - Retrieve
Retrieve operation of resource: nv-satellite-id
satellite-id:
string
in path
ID of satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nv-satellite-interfaces": {
"nv-satellite-interface": [
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"satellite-id": "string"
}
NV-SATELLITE-INTERFACES - Retrieve
Retrieve operation of resource: nv-satellite-interfaces
satellite-id:
string
in path
ID of satellite-id
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nv-satellite-interface": [
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
}
NV-SATELLITE-INTERFACE - Retrieve
Retrieve operation of resource: nv-satellite-interface
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
MEMBER-INTERFACES - Retrieve
Retrieve operation of resource: member-interfaces
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"member-interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
MEMBER-INTERFACE - Retrieve
Retrieve operation of resource: member-interface
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
INPUT - Retrieve
Retrieve operation of resource: input
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
STATUS - Retrieve
Retrieve operation of resource: status
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
STATUS - Retrieve
Retrieve operation of resource: status
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
INPUT - Retrieve
Retrieve operation of resource: input
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
STATUS - Retrieve
Retrieve operation of resource: status
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
STATUS - Retrieve
Retrieve operation of resource: status
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
STATUS - Retrieve
Retrieve operation of resource: status
satellite-id:
string
in path
ID of satellite-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
NODES - Retrieve
Retrieve operation of resource: nodes
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"node": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
NODE - Retrieve
Retrieve operation of resource: node
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-map": {
"interface-table": {
"interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
}
}
POLICY-MAP - Retrieve
Retrieve operation of resource: policy-map
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-table": {
"interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
NODES - Retrieve
Retrieve operation of resource: nodes
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"node": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
NODE - Retrieve
Retrieve operation of resource: node
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
INPUT - Retrieve
Retrieve operation of resource: input
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
MEMBER-INTERFACES - Retrieve
Retrieve operation of resource: member-interfaces
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"member-interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
MEMBER-INTERFACE - Retrieve
Retrieve operation of resource: member-interface
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
SATELLITE-IDS - Retrieve
Retrieve operation of resource: satellite-ids
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"satellite-id": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
SATELLITE-ID - Retrieve
Retrieve operation of resource: satellite-id
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
INPUT - Retrieve
Retrieve operation of resource: input
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
INPUT - Retrieve
Retrieve operation of resource: input
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
SATELLITE-IDS - Retrieve
Retrieve operation of resource: satellite-ids
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"satellite-id": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
SATELLITE-ID - Retrieve
Retrieve operation of resource: satellite-id
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
INPUT - Retrieve
Retrieve operation of resource: input
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
INPUT - Retrieve
Retrieve operation of resource: input
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
node-name:
string
in path
ID of node-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
QOS-GLOBAL - Retrieve
Retrieve operation of resource: qos-global
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vo-q": {
"vo-q-statistics": {
"vo-qinterfaces": {
"vo-qinterface": [
{
"output-vo-q": {
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer"
}
]
}
}
]
}
}
}
]
}
}
}
}
VO-Q - Retrieve
Retrieve operation of resource: vo-q
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vo-q-statistics": {
"vo-qinterfaces": {
"vo-qinterface": [
{
"output-vo-q": {
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
}
]
}
}
}
VO-Q-STATISTICS - Retrieve
Retrieve operation of resource: vo-q-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vo-qinterfaces": {
"vo-qinterface": [
{
"output-vo-q": {
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
}
]
}
}
VO-QINTERFACES - Retrieve
Retrieve operation of resource: vo-qinterfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vo-qinterface": [
{
"output-vo-q": {
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {}
}
]
}
}
]
}
}
}
]
}
VO-QINTERFACE - Retrieve
Retrieve operation of resource: vo-qinterface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output-vo-q": {
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
}
OUTPUT-VO-Q - Retrieve
Retrieve operation of resource: output-vo-q
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer"
}
}
]
}
}
]
}
}
LOCATIONVO-QS - Retrieve
Retrieve operation of resource: locationvo-qs
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"locationvo-q": [
{
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
LOCATIONVO-Q - Retrieve
Retrieve operation of resource: locationvo-q
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer"
}
}
]
}
}
]
}
}
VO-Q-STATS - Retrieve
Retrieve operation of resource: vo-q-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
VO-Q-STATS - Retrieve
Retrieve operation of resource: vo-q-stats
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
VO-Q-MEMBER-INTERFACES - Retrieve
Retrieve operation of resource: vo-q-member-interfaces
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vo-q-member-interface": [
{
"interface-name": "string",
"vo-qoutput": {
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {}
}
]
}
}
]
}
}
}
]
}
VO-Q-MEMBER-INTERFACE - Retrieve
Retrieve operation of resource: vo-q-member-interface
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string",
"vo-qoutput": {
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
}
VO-QOUTPUT - Retrieve
Retrieve operation of resource: vo-qoutput
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
VO-Q-STATS - Retrieve
Retrieve operation of resource: vo-q-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
NODES - Retrieve
Retrieve operation of resource: nodes
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"node": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
NODE - Retrieve
Retrieve operation of resource: node
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
INPUT - Retrieve
Retrieve operation of resource: input
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
node-name:
string
in path
ID of node-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
MEMBER-INTERFACES - Retrieve
Retrieve operation of resource: member-interfaces
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"member-interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
MEMBER-INTERFACE - Retrieve
Retrieve operation of resource: member-interface
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
SATELLITE-IDS - Retrieve
Retrieve operation of resource: satellite-ids
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"satellite-id": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
SATELLITE-ID - Retrieve
Retrieve operation of resource: satellite-id
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
INPUT - Retrieve
Retrieve operation of resource: input
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
INPUT - Retrieve
Retrieve operation of resource: input
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
SATELLITE-IDS - Retrieve
Retrieve operation of resource: satellite-ids
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"satellite-id": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
SATELLITE-ID - Retrieve
Retrieve operation of resource: satellite-id
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
]
}
}
}
INPUT - Retrieve
Retrieve operation of resource: input
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
nv-satellite-id:
string
in path
ID of nv-satellite-id
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
INPUT - Retrieve
Retrieve operation of resource: input
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
OUTPUT - Retrieve
Retrieve operation of resource: output
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
]
}
}
SERVICE-POLICY-NAMES - Retrieve
Retrieve operation of resource: service-policy-names
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
SERVICE-POLICY-INSTANCE - Retrieve
Retrieve operation of resource: service-policy-instance
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer"
}
}
]
}
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
}
]
}
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CHILD-POLICY - Retrieve
Retrieve operation of resource: child-policy
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
CLASS-STATS - Retrieve
Retrieve operation of resource: class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer"
}
]
}
GENERAL-STATS - Retrieve
Retrieve operation of resource: general-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
IPHC-STATS - Retrieve
Retrieve operation of resource: iphc-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
CAC-STATS - Retrieve
Retrieve operation of resource: cac-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
QUEUE-STATS-ARRAY - Retrieve
Retrieve operation of resource: queue-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QUEUE-INSTANCE-LENGTH - Retrieve
Retrieve operation of resource: queue-instance-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-AVERAGE-LENGTH - Retrieve
Retrieve operation of resource: queue-average-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
QUEUE-MAX-LENGTH - Retrieve
Retrieve operation of resource: queue-max-length
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unit": "string",
"value": "integer"
}
POLICE-STATS-ARRAY - Retrieve
Retrieve operation of resource: police-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
COLOR-CLASS-STATS - Retrieve
Retrieve operation of resource: color-class-stats
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
WRED-STATS-ARRAY - Retrieve
Retrieve operation of resource: wred-stats-array
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
RED-LABEL - Retrieve
Retrieve operation of resource: red-label
interface-name:
string
in path
ID of interface-name
service-policy-name:
string
in path
ID of service-policy-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wred-type": "string",
"value": "integer"
}
Schema Definitions
SATELLITE-ID-TABLE:
Common node of interface, member-interface
- satellite-ids: object
-
Satellite ID information
-
- satellite-id: object[]
-
Satellite ID information
-
- nv-satellite-id: string
-
Satellite ID
Example
{
"satellite-ids": {
"satellite-id": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
}
Q-STATS-ST:
Queue limit statistics
- max-threshold-bytes: integer
-
Dropped bytes with the average queue size at the max-threshold
- conform-packets: integer
-
Packets that conform to the queue rate
- queue-drop-threshold: integer
-
tail drop threshold of the queue in bytes
- tail-drop-packets: integer
-
Packets tail dropped
- conform-rate: integer
-
Conform rate
- random-drop-bytes: integer
-
Bytes probabilistically dropped
- max-threshold-packets: integer
-
Dropped packets with the average queue size at the max-threshold
- atm-clp0-drop-bytes: integer
-
ATP CLP 0 matched bytes dropped
- queue-instance-length: POLICY-PARAM-UINT32-ST
-
Queue instance length
-
POLICY-PARAM-UINT32-ST - random-drop-packets: integer
-
Packets probabilistically dropped
- exceed-bytes: integer
-
Bytes that exceed the queue rate
- atm-clp0-drop-packets: integer
-
ATP CLP 0 matched packets dropped
- atm-clp1-drop-packets: integer
-
ATP CLP 0 matched packets dropped
- queue-id: integer
-
Queue Id used for Fabric Stats
- exceed-packets: integer
-
Packets that exceed the queue rate
- atm-clp1-drop-bytes: integer
-
ATP CLP 0 matched bytes dropped
- tail-drop-bytes: integer
-
Bytes tail dropped
- exceed-rate: integer
-
Exceed rate
- forced-wred-stats-display: boolean
-
flag to forcedisplay of WRED even when per WredWRED profile stats is not available
- queue-average-length: POLICY-PARAM-UINT32-ST
-
Queue average length
-
POLICY-PARAM-UINT32-ST - conform-bytes: integer
-
Bytes that conform to the queue rate
- queue-max-length: POLICY-PARAM-UINT32-ST
-
Queue maximum length
-
POLICY-PARAM-UINT32-ST
Example
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer",
"random-drop-bytes": "integer",
"max-threshold-packets": "integer",
"atm-clp0-drop-bytes": "integer",
"queue-instance-length": [
{
"unit": "string",
"value": "integer"
}
],
"random-drop-packets": "integer",
"exceed-bytes": "integer",
"atm-clp0-drop-packets": "integer",
"atm-clp1-drop-packets": "integer",
"queue-id": "integer",
"exceed-packets": "integer",
"atm-clp1-drop-bytes": "integer",
"tail-drop-bytes": "integer",
"exceed-rate": "integer",
"forced-wred-stats-display": "boolean",
"queue-average-length": [
{
"unit": "string",
"value": "integer"
}
],
"conform-bytes": "integer",
"queue-max-length": [
{
"unit": "string",
"value": "integer"
}
]
}
QOS-MA-SAT-IF-EDM-INFO-XML:
QoS offload information on Satellite interface
- status: string
-
Status of offload
- policy-name: string
-
Service policy name
- direction: string input, output, unknown
-
Satellite caps type
- last-operation: string add, remove, replace, modify, unknown
-
Previous caps operation
- error-message: string
-
Error message
Example
{
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
GEN-STATS-ST:
Counters common to all features
- transmit-packets: integer
-
Transmitted packets (packets/bytes)
- total-drop-bytes: integer
-
Dropped bytes (packets/bytes)
- pre-policy-matched-bytes: integer
-
Matched bytes before applying policy
- total-transmit-rate: integer
-
Total transmit rate in kbps
- total-drop-rate: integer
-
Total drop rate (packets/bytes)
- total-drop-packets: integer
-
Dropped packets (packets/bytes)
- pre-policy-matched-packets: integer
-
Matched pkts before applying policy
- transmit-bytes: integer
-
Transmitted bytes (packets/bytes)
- match-data-rate: integer
-
Incoming matched data rate in kbps
Example
{
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
}
PLC-STATS-ST:
Policer statistics
- parent-drop-packets: integer
-
Dropped pkts by the parent policer
- violate-packets: integer
-
Packets violating the policed rate
- drop-bytes: integer
-
Police dropped bytes
- conform-packets: integer
-
Packets that conform to the policed rate
- drop-packets: integer
-
Police dropped packets
- exceed-rate: integer
-
Exceed rate in kbps
- color-class-stats: PLC-COLOR-CLASS-STATS-ST
-
color class stats
- exceed-packets: integer
-
Packets that exceed the policed rate
- conform-rate: integer
-
Conform rate in kbps
- conform-bytes: integer
-
Bytes that conform to the policed rate
- parent-drop-bytes: integer
-
Dropped bytes by the parent policer
- violate-rate: integer
-
Violate rate in kbps
- exceed-bytes: integer
-
Bytes that exceed the policed rate
- violate-bytes: integer
-
Bytes that violate the policed rate
Example
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
CLASS-STATS:
CLASS STATS
- child-policy: CHILD-POLICY-QOS-STATS
-
child policy
- shared-queue-id: integer
-
q-id of the shared queue for this class
- police-stats-array: PLC-STATS-ST
-
array of police stats
-
PLC-STATS-ST - general-stats: GEN-STATS-ST
-
general stats
- cac-stats: CAC-STATS-ST
-
bag for cac stats
- class-name: string
-
ClassName
- queue-descr: string
-
Description of queue for the class
- wred-stats-array: RED-PROFILE-STATS
-
array of red stats
-
RED-PROFILE-STATS - counter-validity-bitmask: integer
-
Bitmask to indicate which counter or counters are undetermined. Counters will be marked undetermined when one or more classes share queues with class-default because in such cases the value of counters for each class is invalid. Based on the flag(s) set, the following counters will be marked undetermined. For example, if value of this object returned is 0x00000101, counters TransmitPackets/TransmitBytes/TotalTransmitRate and DropPackets/DropBytes are undetermined .0x00000001 - Transmit (TransmitPackets/TransmitBytes/TotalTransmitRate ), 0x00000002 - Total drop (TotalDropPackets/TotalDropBytes/TotalDropRate), 0x00000004 - Match (MatchDataRate/PrepolicyMatchedPackets /PrepolicyMatchedBytes), 0x00000100 - Police drop (DropPackets/DropBytes), 0x00000200 - Police conform (ConformPackets/ConformBytes/ConformRate), 0x00000400 - Police exceed (ExceedPackets/ExceedBytes/ExceedRate), 0x00000800 - Police violate (ViolatePackets/ViolateBytes/ViolateRate), 0x00001000 - Parent policer drop (ParentDropPackets/ParentDropBytes), 0x00010000
- Queueing drop (TailDropPackets/TailDropBytes), 0x00020000 - Red queue drop (RandomDropPackets/RandomDropBytes), 0x00040000
- Queue maximum threshold drop (MaxThresholdPackets/MaxThresholdBytes), 0x00080000 - Queue conform (ConformPackets/ConformBytes/ConformRate), 0x00100000 - Queue exceed (ExceedPackets/ExceedBytes/ExceedRate), 0x00200000 - CLP limit drop (ATM_CLP0DropPackets/ATM_CLP0DropBytes /ATM_CLP1DropPackets/ATM_CLP1DropBytes), 0x01000000 - RED transmit (RedTransmitPackets/RedTransmitBytes), 0x02000000 - RED drop (RandomDropPackets/RandomDropBytes), 0x04000000
- RED maximum threshold drop (MaxThresholdPackets/MaxThresholdBytes)
- cac-state: string unknown, admit, redirect, ubrl
-
CACState
- iphc-stats: IPHC-STATS-ST
-
IPHC stats
- queue-stats-array: Q-STATS-ST
-
array of queue stats
-
Q-STATS-ST
Example
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
null
]
}
]
}
}
PLC-COLOR-CLASS-STATS-ST:
Color Aware Policer statistics
- conform-class-conform-rate: integer
-
Conform Class Conform rate in kbps
- conform-class-exceed-packets: integer
-
Packets with classification result conform and policer result exceed
- exceed-class-exceed-bytes: integer
-
Bytes with classification result exceed and policer result exceed
- conform-class-violate-packets: integer
-
Packets with classification result conform and policer result violate
- violate-class-violate-packets: integer
-
Packets with classification result violate and policer result violate
- conform-class-conform-packets: integer
-
Packets with classification result conform and policer result conform
- violate-class-violate-rate: integer
-
Violate Class Violate rate in kbps
- conform-class-exceed-bytes: integer
-
Bytes with classification result conform and policer result exceed
- exceed-class-violate-rate: integer
-
Exceed Class Violate rate in kbps
- conform-class-conform-bytes: integer
-
Bytes with classification result conform and policer result conform
- exceed-class-exceed-rate: integer
-
Exceed Class Exceed rate in kbps
- violate-class-violate-bytes: integer
-
Bytes with classification result violate and policer result violate
- conform-class-exceed-rate: integer
-
Conform Class Exceed rate in kbps
- exceed-class-violate-bytes: integer
-
Bytes with classification result exceed and policer result violate
- exceed-class-violate-packets: integer
-
Packets with classification result exceed and policer result violate
- exceed-class-exceed-packets: integer
-
Packets with classification result exceed and policer result exceed
- conform-class-violate-rate: integer
-
Conform Class Violate rate in kbps
- conform-class-violate-bytes: integer
-
Bytes with classification result conform and policer result violate
Example
{
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
}
QOS-PI-OPER-OUTPUT:
Common node of shared-policy-instance, member-interface, interface, nv-satellite-interface, satellite-id
- output: object
-
A piece of QoS policy-map operational data for an interface
-
- service-policy-names: object
-
Operational data for all Policy instance
-
- service-policy-instance: object[]
-
QoS policy-map operational data for a particular Policy
-
- service-policy-name: string
-
Name of the policy instance
Example
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {}
}
]
}
}
]
}
}
]
}
}
}
INTERFACE-TABLE:
Common node of qos, policy-map
- interface-table: INTERFACE
-
Operational data for all interfaces
Example
{
"interface-table": {
"interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
}
CHILD-POLICY-QOS-STATS:
policy map statistics
- policy-name: string
-
PolicyName
- state: string active, suspended
-
State
- class-stats: CHILD-POLICY-CLASS-STATS
-
array of classes contained in policy
-
CHILD-POLICY-CLASS-STATS - satid: integer
-
to maintain satellite id
- state-description: string
-
StateDescription
Example
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{}
]
}
]
}
STATUS:
Common node of input, output, nv-satellite-interface
- status: QOS-MA-SAT-IF-EDM-INFO-XML
-
Policy-map status operational data for an interface
Example
{
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
RED-PROFILE-STATS:
Per RED profile stats
- max-threshold-bytes: integer
-
Dropped bytes with the average queue size at the max-threshold
- random-drop-bytes: integer
-
Probabilisticallydropped bytes
- red-label: WRED-TYPE-VALUE
-
Array of WRED Typevalues as in PRP stats is available per threshold
-
WRED-TYPE-VALUE - profile-title: string
-
ProfileTitle
- max-threshold-packets: integer
-
Dropped packets with the average queue size at the max-threshold
- red-ecn-marked-bytes: integer
-
ECN marked bytes
- random-drop-packets: integer
-
Probabilistically dropped packets
- red-transmit-packets: integer
-
Transmitted packets
- red-transmit-bytes: integer
-
Transmitted bytes
- red-ecn-marked-packets: integer
-
ECN marked packets
Example
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
IPHC-STATS-ST:
IPHC Stats
- non-tcp-total-out-packets: integer
-
TotalNum of Non tcp pkts sent
- tcp-bytes-sent-rate: integer
-
Compressed Tcp Bytes sent rate
- tcp-total-out-bytes: integer
-
TotalNum of Tcp Bytes sent
- non-tcp-bytes-sent-rate: integer
-
Compressed Non Tcp Bytes sent rate
- non-tcp-full-header-packets-out: integer
-
Num of non tcp fullheader pkts sent
- non-tcp-bytes-saved: integer
-
Non Tcp Bytes saved due to compression
- tcp-full-header-packets-out: integer
-
Num of tcp fullheader pkts sent
- tcp-bytes-saved: integer
-
Tcp Bytes saved due to compression
- tcp-total-out-packets: integer
-
Total Num of tcp pkts sent
- tcp-compressed-packets-out: integer
-
Num of tcp compressed pkts sent
- non-tcp-compressed-packets-out: integer
-
Num of non tcp compressed pkts sent
- non-tcp-total-out-bytes: integer
-
TotalNum of Non Tcp Bytes sent
Example
{
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
}
CAC-STATS-ST:
CAC statistics
- admit-rates: integer
-
CAC admit rate
- drop-bytes: integer
-
CAC dropped bytes
- drop-packets: integer
-
CAC dropped packets
- admitpackets: integer
-
Admitted packets (pkts/bytes)
- admit-bytes: integer
-
Admitted bytes (pkts/bytes)
- drop-rates: integer
-
CAC dropped rate
Example
{
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
}
POLICY-PARAM-UINT32-ST:
POLICY PARAM UINT32 ST
- unit: string policy-param-unit-invalid, policy-param-unit-bytes, policy-param-unit-kbytes, policy-param-unit-mbytes, policy-param-unit-gbytes, policy-param-unit-bitsps, policy-param-unit-kbitsps, policy-param-unit-mbitsps, policy-param-unit-gbitsps, policy-param-unit-cells-ps, policy-param-unit-packets-ps, policy-param-unit-us, policy-param-unit-ms, policy-param-unit-seconds, policy-param-unit-packets, policy-param-unit-cells, policy-param-unit-percent, policy-param-unit-per-thousand, policy-param-unit-per-million, policy-param-unit-hz, policy-param-unit-khz, policy-param-unit-mhz, policy-param-unit-ratio, policy-param-unit-max
-
unit
- value: integer
-
value
Example
{
"unit": "string",
"value": "integer"
}
VO-Q-STATS:
Common node of locationvo-q, output-vo-q, vo-qoutput
- vo-q-stats: QOS-STATS
-
VoQ statistics operational data for an interface
Example
{
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer"
}
}
]
}
}
]
}
}
CHILD-POLICY-CLASS-STATS:
CHILD POLICY CLASS STATS
- shared-queue-id: integer
-
q-id of the shared queue for this class
- police-stats-array: PLC-STATS-ST
-
array of police stats
-
PLC-STATS-ST - general-stats: GEN-STATS-ST
-
general stats
- cac-stats: CAC-STATS-ST
-
bag for cac stats
- class-name: string
-
ClassName
- queue-descr: string
-
Description of queue for the class
- wred-stats-array: RED-PROFILE-STATS
-
array of red stats
-
RED-PROFILE-STATS - counter-validity-bitmask: integer
-
Bitmask to indicate which counter or counters are undetermined. Counters will be marked undetermined when one or more classes share queues with class-default because in such cases the value of counters for each class is invalid. Based on the flag(s) set, the following counters will be marked undetermined. For example, if value of this object returned is 0x00000101, counters TransmitPackets/TransmitBytes/TotalTransmitRate and DropPackets/DropBytes are undetermined .0x00000001 - Transmit (TransmitPackets/TransmitBytes/TotalTransmitRate ), 0x00000002 - Total drop (TotalDropPackets/TotalDropBytes/TotalDropRate), 0x00000004 - Match (MatchDataRate/PrepolicyMatchedPackets /PrepolicyMatchedBytes), 0x00000100 - Police drop (DropPackets/DropBytes), 0x00000200 - Police conform (ConformPackets/ConformBytes/ConformRate), 0x00000400 - Police exceed (ExceedPackets/ExceedBytes/ExceedRate), 0x00000800 - Police violate (ViolatePackets/ViolateBytes/ViolateRate), 0x00001000 - Parent policer drop (ParentDropPackets/ParentDropBytes), 0x00010000
- Queueing drop (TailDropPackets/TailDropBytes), 0x00020000 - Red queue drop (RandomDropPackets/RandomDropBytes), 0x00040000
- Queue maximum threshold drop (MaxThresholdPackets/MaxThresholdBytes), 0x00080000 - Queue conform (ConformPackets/ConformBytes/ConformRate), 0x00100000 - Queue exceed (ExceedPackets/ExceedBytes/ExceedRate), 0x00200000 - CLP limit drop (ATM_CLP0DropPackets/ATM_CLP0DropBytes /ATM_CLP1DropPackets/ATM_CLP1DropBytes), 0x01000000 - RED transmit (RedTransmitPackets/RedTransmitBytes), 0x02000000 - RED drop (RandomDropPackets/RandomDropBytes), 0x04000000
- RED maximum threshold drop (MaxThresholdPackets/MaxThresholdBytes)
- cac-state: string unknown, admit, redirect, ubrl
-
CACState
- iphc-stats: IPHC-STATS-ST
-
IPHC stats
- queue-stats-array: Q-STATS-ST
-
array of queue stats
-
Q-STATS-ST
Example
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer",
"tcp-total-out-packets": "integer",
"tcp-compressed-packets-out": "integer",
"non-tcp-compressed-packets-out": "integer",
"non-tcp-total-out-bytes": "integer"
},
"queue-stats-array": [
{
"max-threshold-bytes": "integer",
"conform-packets": "integer",
"queue-drop-threshold": "integer",
"tail-drop-packets": "integer",
"conform-rate": "integer"
}
]
}
OUTPUT:
Common node of member-interface, nv-satellite-interface
- output: STATUS
-
A piece of QoS policy-map operational data for an interface
Example
{
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
INPUT:
Common node of member-interface, nv-satellite-interface
- input: STATUS
-
A piece of QoS policy-map operational data for an interface
Example
{
"input": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
MEMBER-INTERFACE-TABLE:
Common node of interface, nv-satellite-interface, shared-policy-instance
- member-interfaces: object
-
QoS policy-map member interface table
-
- member-interface: object[]
-
QoS policy-map member interface statistics
-
- interface-name: string
-
Name of member interface
Example
{
"member-interfaces": {
"member-interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
}
QOS-STATS:
policy map statistics
- policy-name: string
-
PolicyName
- state: string active, suspended
-
State
- class-stats: CLASS-STATS
-
array of classes contained in policy
-
CLASS-STATS - satid: integer
-
to maintain satellite id
- state-description: string
-
StateDescription
Example
{
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer",
"tcp-full-header-packets-out": "integer",
"tcp-bytes-saved": "integer"
}
}
]
}
}
]
}
STATISTICS:
Common node of input, output
- statistics: QOS-STATS
-
Policy-map statistics operational data for an interface
Example
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer",
"non-tcp-full-header-packets-out": "integer",
"non-tcp-bytes-saved": "integer"
}
}
]
}
}
]
}
}
WRED-TYPE-VALUE:
WRED Type Value pairs
- wred-type: string wred-cos-cmd, wred-dscp-cmd, wred-precedence-cmd, wred-discard-class-cmd, wred-mpls-exp-cmd, red-with-user-min-max, red-with-default-min-max, wred-dei-cmd, wred-ecn-cmd, wred-invalid-cmd
-
WRED type DSCP, EXP, PREC etc.
- value: integer
-
WRED value for this type.
Example
{
"wred-type": "string",
"value": "integer"
}
INTERFACE:
Common node of interface-table, nv-interface-table
- interface: object[]
-
QoS policy-map operational data for a particular interface
-
- nodes: object
-
QoS policy-map node table
-
- node: object[]
-
QoS operational data for a particular node
-
- node-name: string
-
The node
- interface-name: string
-
Name of the interface
Example
{
"interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
QOS-PI-OPER-INPUT:
Common node of shared-policy-instance, member-interface, interface, nv-satellite-interface, satellite-id
- input: object
-
A piece of QoS policy-map operational data for an interface
-
- service-policy-names: object
-
Operational data for all Policy instance
-
- service-policy-instance: object[]
-
QoS policy-map operational data for a particular Policy
-
- service-policy-name: string
-
Name of the policy instance
Example
{
"input": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {}
}
]
}
}
]
}
}
]
}
}
}
qos_schema:
QoS operational data
- nodes: object
-
Node-specific QoS operational data
-
- node: object[]
-
QoS operational data for a particular node
-
object - policy-map:
-
Operational data for policymaps
- node-name: string
-
The node
- qos-global: object
-
For global registrations
-
- vo-q: object
-
For VoQ operational data
-
- vo-q-statistics: object
-
For VoQ statistics
-
- vo-qinterfaces: object
-
VoQ interface
-
- vo-qinterface: object[]
-
QoS policy-map operational data for a particular interface
-
object - output-vo-q:
-
output VoQ interface
- vo-q-member-interfaces: object
-
VoQ QoS policy-map member interface table
-
- vo-q-member-interface: object[]
-
QoS policy-map member interface statistics
-
object - interface-name: string
-
Name of member interface
- vo-qoutput: VO-Q-STATS
-
output VoQ interface
- interface-name: string
-
Name of the interface
- nv-satellite: object
-
Satellite table
-
- nv-satellite-status: object
-
Satellite QOS offload status based on Satellite ID
-
- nv-satellite-ids: object
-
Satellite ID table
-
- nv-satellite-id: object[]
-
Satellite ID information
-
object - nv-satellite-interfaces: object
-
QOS offload status of satellite interface of a particular satellite
-
- nv-satellite-interface: object[]
-
QOS offload status for a particular satellite interface
-
- satellite-id: string
-
Satellite ID
- nv-satellite-statistics: object
-
Satellite statistics based on Satellite ID
-
- nv-satellite-ids: object
-
Satellite ID table
-
- nv-satellite-id: object[]
-
Satellite ID information
-
object - nv-satellite-interfaces: object
-
Operational data of satellite interface of a particular satellite
-
- nv-satellite-interface: object[]
-
Operational data for a particular satellite interface
-
- interface-name: string
-
Name of the interface
- satellite-id: string
-
Satellite ID
- nv-interface-table: INTERFACE
-
Operational data for satellite interfaces
Example
{
"interface-table": {
"interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
}
nodes_schema:
QoS policy-map node table
- node: QOS-PI-OPER-OUTPUT
-
QoS operational data for a particular node
-
QOS-PI-OPER-OUTPUT
Example
{
"node": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer"
}
]
}
}
]
}
}
]
}
}
}
]
}
input_schema:
A piece of QoS policy-map operational data for an interface
- service-policy-names: object
-
Operational data for all Policy instance
-
- service-policy-instance: STATISTICS
-
QoS policy-map operational data for a particular Policy
-
STATISTICS
Example
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
}
service-policy-names_schema:
Operational data for all Policy instance
- service-policy-instance: STATISTICS
-
QoS policy-map operational data for a particular Policy
-
STATISTICS
Example
{
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer"
}
}
]
}
}
]
}
}
]
}
output_schema:
A piece of QoS policy-map operational data for an interface
- service-policy-names: object
-
Operational data for all Policy instance
-
- service-policy-instance: STATISTICS
-
QoS policy-map operational data for a particular Policy
-
STATISTICS
Example
{
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
}
member-interfaces_schema:
QoS policy-map member interface table
- member-interface: QOS-PI-OPER-OUTPUT
-
QoS policy-map member interface statistics
-
QOS-PI-OPER-OUTPUT
Example
{
"member-interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer"
}
]
}
}
]
}
}
]
}
}
}
]
}
satellite-ids_schema:
Satellite ID information
- satellite-id: QOS-PI-OPER-OUTPUT
-
Satellite ID information
-
QOS-PI-OPER-OUTPUT
Example
{
"satellite-id": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer"
}
]
}
}
]
}
}
]
}
}
}
]
}
nv-satellite_schema:
Satellite table
- nv-satellite-status: object
-
Satellite QOS offload status based on Satellite ID
-
- nv-satellite-ids: object
-
Satellite ID table
-
- nv-satellite-id: object[]
-
Satellite ID information
-
object - nv-satellite-interfaces: object
-
QOS offload status of satellite interface of a particular satellite
-
- nv-satellite-interface: object[]
-
QOS offload status for a particular satellite interface
-
- satellite-id: string
-
Satellite ID
- nv-satellite-statistics: object
-
Satellite statistics based on Satellite ID
-
- nv-satellite-ids: object
-
Satellite ID table
-
- nv-satellite-id: object[]
-
Satellite ID information
-
object - nv-satellite-interfaces: object
-
Operational data of satellite interface of a particular satellite
-
- nv-satellite-interface: object[]
-
Operational data for a particular satellite interface
-
- interface-name: string
-
Name of the interface
- satellite-id: string
-
Satellite ID
Example
{
"nv-satellite-status": {
"nv-satellite-ids": {
"nv-satellite-id": [
{
"nv-satellite-interfaces": {
"nv-satellite-interface": [
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"satellite-id": "string"
}
]
}
},
"nv-satellite-statistics": {
"nv-satellite-ids": {
"nv-satellite-id": [
{
"nv-satellite-interfaces": {
"nv-satellite-interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
}
]
}
}
}
nv-satellite-statistics_schema:
Satellite statistics based on Satellite ID
- nv-satellite-ids: object
-
Satellite ID table
-
- nv-satellite-id: object[]
-
Satellite ID information
-
object - nv-satellite-interfaces: object
-
Operational data of satellite interface of a particular satellite
-
- nv-satellite-interface: object[]
-
Operational data for a particular satellite interface
-
- interface-name: string
-
Name of the interface
- satellite-id: string
-
Satellite ID
Example
{
"nv-satellite-ids": {
"nv-satellite-id": [
{
"nv-satellite-interfaces": {
"nv-satellite-interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
}
]
}
}
nv-satellite-ids_schema:
Satellite ID table
- nv-satellite-id: object[]
-
Satellite ID information
-
object - nv-satellite-interfaces: object
-
QOS offload status of satellite interface of a particular satellite
-
- nv-satellite-interface: object[]
-
QOS offload status for a particular satellite interface
-
- satellite-id: string
-
Satellite ID
Example
{
"nv-satellite-id": [
{
"nv-satellite-interfaces": {
"nv-satellite-interface": [
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"satellite-id": "string"
}
]
}
nv-satellite-id_schema:
- nv-satellite-interfaces: object
-
QOS offload status of satellite interface of a particular satellite
-
- nv-satellite-interface: object[]
-
QOS offload status for a particular satellite interface
-
- satellite-id: string
-
Satellite ID
Example
{
"nv-satellite-interfaces": {
"nv-satellite-interface": [
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"satellite-id": "string"
}
nv-satellite-interfaces_schema:
QOS offload status of satellite interface of a particular satellite
- nv-satellite-interface: object[]
-
QOS offload status for a particular satellite interface
-
Example
{
"nv-satellite-interface": [
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
}
nv-satellite-interface_schema:
- member-interfaces: object
-
Satellite member interface table
-
- member-interface: object[]
-
Satellite member interface statistics
-
- interface-name: string
-
Name of member interface
- interface-name: string
-
Name of the interface
Example
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
nv-satellite-status_schema:
Satellite QOS offload status based on Satellite ID
- nv-satellite-ids: object
-
Satellite ID table
-
- nv-satellite-id: object[]
-
Satellite ID information
-
object - nv-satellite-interfaces: object
-
QOS offload status of satellite interface of a particular satellite
-
- nv-satellite-interface: object[]
-
QOS offload status for a particular satellite interface
-
- satellite-id: string
-
Satellite ID
Example
{
"nv-satellite-ids": {
"nv-satellite-id": [
{
"nv-satellite-interfaces": {
"nv-satellite-interface": [
{
"member-interfaces": {
"member-interface": [
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
]
},
"satellite-id": "string"
}
]
}
}
member-interface_schema:
- interface-name: string
-
Name of member interface
Example
{
"interface-name": "string",
"output": {
"status": {
"status": "string",
"policy-name": "string",
"direction": "string",
"last-operation": "string",
"error-message": "string"
}
}
}
node_schema:
- policy-map:
-
Operational data for policymaps
- node-name: string
-
The node
Example
{
"policy-map": {
"interface-table": {
"interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
}
}
policy-map_schema:
Operational data for policymaps
- shared-policy-instances: object
-
Operational data for all SPI
-
- shared-policy-instance: object[]
-
QoS policy-map operational data for a particular SPI
-
- spi-name: string
-
Name of the shared policy instance
Example
{
"interface-table": {
"interface": [
{
"output": {
"service-policy-names": {
"service-policy-instance": [
{
"statistics": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer"
}
]
}
]
}
}
]
}
}
]
}
}
}
]
}
}
qos-global_schema:
For global registrations
- vo-q: object
-
For VoQ operational data
-
- vo-q-statistics: object
-
For VoQ statistics
-
- vo-qinterfaces: object
-
VoQ interface
-
- vo-qinterface: object[]
-
QoS policy-map operational data for a particular interface
-
object - output-vo-q:
-
output VoQ interface
- vo-q-member-interfaces: object
-
VoQ QoS policy-map member interface table
-
- vo-q-member-interface: object[]
-
QoS policy-map member interface statistics
-
object - interface-name: string
-
Name of member interface
- vo-qoutput: VO-Q-STATS
-
output VoQ interface
- interface-name: string
-
Name of the interface
Example
{
"vo-q": {
"vo-q-statistics": {
"vo-qinterfaces": {
"vo-qinterface": [
{
"output-vo-q": {
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
}
]
}
}
}
}
vo-q_schema:
For VoQ operational data
- vo-q-statistics: object
-
For VoQ statistics
-
- vo-qinterfaces: object
-
VoQ interface
-
- vo-qinterface: object[]
-
QoS policy-map operational data for a particular interface
-
object - output-vo-q:
-
output VoQ interface
- vo-q-member-interfaces: object
-
VoQ QoS policy-map member interface table
-
- vo-q-member-interface: object[]
-
QoS policy-map member interface statistics
-
object - interface-name: string
-
Name of member interface
- vo-qoutput: VO-Q-STATS
-
output VoQ interface
- interface-name: string
-
Name of the interface
Example
{
"vo-q-statistics": {
"vo-qinterfaces": {
"vo-qinterface": [
{
"output-vo-q": {
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string"
}
]
}
}
]
}
}
}
]
}
}
}
vo-q-statistics_schema:
For VoQ statistics
- vo-qinterfaces: object
-
VoQ interface
-
- vo-qinterface: object[]
-
QoS policy-map operational data for a particular interface
-
object - output-vo-q:
-
output VoQ interface
- vo-q-member-interfaces: object
-
VoQ QoS policy-map member interface table
-
- vo-q-member-interface: object[]
-
QoS policy-map member interface statistics
-
object - interface-name: string
-
Name of member interface
- vo-qoutput: VO-Q-STATS
-
output VoQ interface
- interface-name: string
-
Name of the interface
Example
{
"vo-qinterfaces": {
"vo-qinterface": [
{
"output-vo-q": {
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {}
}
]
}
}
]
}
}
}
]
}
}
vo-qinterfaces_schema:
VoQ interface
- vo-qinterface: object[]
-
QoS policy-map operational data for a particular interface
-
object - output-vo-q:
-
output VoQ interface
- vo-q-member-interfaces: object
-
VoQ QoS policy-map member interface table
-
- vo-q-member-interface: object[]
-
QoS policy-map member interface statistics
-
object - interface-name: string
-
Name of member interface
- vo-qoutput: VO-Q-STATS
-
output VoQ interface
- interface-name: string
-
Name of the interface
Example
{
"vo-qinterface": [
{
"output-vo-q": {
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
}
]
}
vo-qinterface_schema:
- output-vo-q:
-
output VoQ interface
- vo-q-member-interfaces: object
-
VoQ QoS policy-map member interface table
-
- vo-q-member-interface: object[]
-
QoS policy-map member interface statistics
-
object - interface-name: string
-
Name of member interface
- vo-qoutput: VO-Q-STATS
-
output VoQ interface
- interface-name: string
-
Name of the interface
Example
{
"output-vo-q": {
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer"
}
}
]
}
}
]
}
}
}
output-vo-q_schema:
output VoQ interface
- locationvo-qs: object
-
QoS policy-map location table
-
- locationvo-q: object[]
-
QoS operational data for a particular location
-
- node-name: string
-
The node
Example
{
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
locationvo-qs_schema:
QoS policy-map location table
- locationvo-q: object[]
-
QoS operational data for a particular location
-
- node-name: string
-
The node
Example
{
"locationvo-q": [
{
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
]
}
locationvo-q_schema:
- node-name: string
-
The node
Example
{
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer",
"non-tcp-bytes-sent-rate": "integer"
}
}
]
}
}
]
}
}
vo-q-member-interfaces_schema:
VoQ QoS policy-map member interface table
- vo-q-member-interface: object[]
-
QoS policy-map member interface statistics
-
object - interface-name: string
-
Name of member interface
- vo-qoutput: VO-Q-STATS
-
output VoQ interface
Example
{
"vo-q-member-interface": [
{
"interface-name": "string",
"vo-qoutput": {
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer"
}
}
]
}
}
]
}
}
}
]
}
vo-q-member-interface_schema:
- interface-name: string
-
Name of member interface
- vo-qoutput: VO-Q-STATS
-
output VoQ interface
Example
{
"interface-name": "string",
"vo-qoutput": {
"vo-q-stats": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"child-policy": {
"policy-name": "string",
"state": "string",
"class-stats": [
{
"shared-queue-id": "integer",
"police-stats-array": [
{
"parent-drop-packets": "integer",
"violate-packets": "integer",
"drop-bytes": "integer",
"conform-packets": "integer",
"drop-packets": "integer",
"exceed-rate": "integer",
"color-class-stats": {
"conform-class-conform-rate": "integer",
"conform-class-exceed-packets": "integer",
"exceed-class-exceed-bytes": "integer",
"conform-class-violate-packets": "integer",
"violate-class-violate-packets": "integer",
"conform-class-conform-packets": "integer",
"violate-class-violate-rate": "integer",
"conform-class-exceed-bytes": "integer",
"exceed-class-violate-rate": "integer",
"conform-class-conform-bytes": "integer",
"exceed-class-exceed-rate": "integer",
"violate-class-violate-bytes": "integer",
"conform-class-exceed-rate": "integer",
"exceed-class-violate-bytes": "integer",
"exceed-class-violate-packets": "integer",
"exceed-class-exceed-packets": "integer",
"conform-class-violate-rate": "integer",
"conform-class-violate-bytes": "integer"
},
"exceed-packets": "integer",
"conform-rate": "integer",
"conform-bytes": "integer",
"parent-drop-bytes": "integer",
"violate-rate": "integer",
"exceed-bytes": "integer",
"violate-bytes": "integer"
}
],
"general-stats": {
"transmit-packets": "integer",
"total-drop-bytes": "integer",
"pre-policy-matched-bytes": "integer",
"total-transmit-rate": "integer",
"total-drop-rate": "integer",
"total-drop-packets": "integer",
"pre-policy-matched-packets": "integer",
"transmit-bytes": "integer",
"match-data-rate": "integer"
},
"cac-stats": {
"admit-rates": "integer",
"drop-bytes": "integer",
"drop-packets": "integer",
"admitpackets": "integer",
"admit-bytes": "integer",
"drop-rates": "integer"
},
"class-name": "string",
"queue-descr": "string",
"wred-stats-array": [
{
"max-threshold-bytes": "integer",
"random-drop-bytes": "integer",
"red-label": [
{
"wred-type": "string",
"value": "integer"
}
],
"profile-title": "string",
"max-threshold-packets": "integer",
"red-ecn-marked-bytes": "integer",
"random-drop-packets": "integer",
"red-transmit-packets": "integer",
"red-transmit-bytes": "integer",
"red-ecn-marked-packets": "integer"
}
],
"counter-validity-bitmask": "integer",
"cac-state": "string",
"iphc-stats": {
"non-tcp-total-out-packets": "integer",
"tcp-bytes-sent-rate": "integer",
"tcp-total-out-bytes": "integer"
}
}
]
}
}
]
}
}
}